rtc23.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef RTC23_H
#define RTC23_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define RTC23_REG_HUNDREDTHS                        0x00
#define RTC23_REG_SECONDS                           0x01
#define RTC23_REG_MINUTES                           0x02
#define RTC23_REG_HOURS                             0x03
#define RTC23_REG_DATE                              0x04
#define RTC23_REG_MONTHS                            0x05
#define RTC23_REG_YEARS                             0x06
#define RTC23_REG_WEEKDAYS                          0x07
#define RTC23_REG_HUNDREDTHS_ALARM                  0x08
#define RTC23_REG_SECONDS_ALARM                     0x09
#define RTC23_REG_MINUTES_ALARM                     0x0A
#define RTC23_REG_HOURS_ALARM                       0x0B
#define RTC23_REG_DATE_ALARM                        0x0C
#define RTC23_REG_MONTHS_ALARM                      0x0D
#define RTC23_REG_WEEKDAYS_ALARM                    0x0E
#define RTC23_REG_STATUS                            0x0F
#define RTC23_REG_CONTROL1                          0x10
#define RTC23_REG_CONTROL2                          0x11
#define RTC23_REG_INT_MASK                          0x12
#define RTC23_REG_SQW                               0x13
#define RTC23_REG_CAL_XT                            0x14
#define RTC23_REG_CAL_RC_HI                         0x15
#define RTC23_REG_CAL_RC_LOW                        0x16
#define RTC23_REG_SLEEP_CONTROL                     0x17
#define RTC23_REG_TIMER_CONTROL                     0x18
#define RTC23_REG_TIMER                             0x19
#define RTC23_REG_TIMER_INITIAL                     0x1A
#define RTC23_REG_WDT                               0x1B
#define RTC23_REG_OSC_CONTROL                       0x1C
#define RTC23_REG_OSC_STATUS                        0x1D
#define RTC23_REG_CONFIGURATION_KEY                 0x1F
#define RTC23_REG_TRICKLE                           0x20
#define RTC23_REG_BREF_CONTROL                      0x21
#define RTC23_REG_AFCTRL                            0x26
#define RTC23_REG_BATMODE_IO                        0x27
#define RTC23_REG_ID0                               0x28
#define RTC23_REG_ID1                               0x29
#define RTC23_REG_ID2                               0x2A
#define RTC23_REG_ID3                               0x2B
#define RTC23_REG_ID4                               0x2C
#define RTC23_REG_ID5                               0x2D
#define RTC23_REG_ID6                               0x2E
#define RTC23_REG_ASTAT                             0x2F
#define RTC23_REG_OCTRL                             0x30
#define RTC23_REG_EXTENSION_ADDRESS                 0x3F
#define RTC23_REG_RAM                               0x40
 // rtc23_reg



#define RTC23_MONDAY                                0x00
#define RTC23_TUESDAY                               0x01
#define RTC23_WEDNESDAY                             0x02
#define RTC23_THURSDAY                              0x03
#define RTC23_FRIDAY                                0x04
#define RTC23_SATURDAY                              0x05
#define RTC23_SUNDAY                                0x06

#define RTC23_DEVICE_ID                             0x18

#define RTC23_SET_DATA_SAMPLE_EDGE                  SET_SPI_DATA_SAMPLE_EDGE
#define RTC23_SET_DATA_SAMPLE_MIDDLE                SET_SPI_DATA_SAMPLE_MIDDLE
 // rtc23_set



#define RTC23_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.psw = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.wdi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // rtc23_map // rtc23

typedef struct
{
    // Output pins
    digital_out_t wdi;          
 
    // Input pins
    digital_in_t psw;           
    digital_in_t int_pin;       
 
    // Modules
    spi_master_t spi;           
 
    pin_name_t   chip_select;   
 
} rtc23_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
 
    // Additional gpio pins
    pin_name_t wdi;             
    pin_name_t psw;             
    pin_name_t int_pin;         
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
} rtc23_cfg_t;

typedef struct
{
    uint8_t second_100th;
    uint8_t second;
    uint8_t minute;
    uint8_t hour;
 
} rtc23_time_t;

typedef struct
{
    uint8_t day_of_week;
    uint8_t day;
    uint8_t month;
    uint8_t year;
 
} rtc23_date_t;

typedef enum
{
    RTC23_OK = 0,
    RTC23_ERROR = -1
 
} rtc23_return_value_t;


void rtc23_cfg_setup ( rtc23_cfg_t *cfg );

err_t rtc23_init ( rtc23_t *ctx, rtc23_cfg_t *cfg );

err_t rtc23_write_regs ( rtc23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t rtc23_read_regs ( rtc23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

err_t rtc23_write_reg ( rtc23_t *ctx, uint8_t reg, uint8_t data_in );

err_t rtc23_read_reg ( rtc23_t *ctx, uint8_t reg, uint8_t *data_out );

void rtc23_set_wdi_pin ( rtc23_t *ctx, uint8_t state );

uint8_t rtc23_get_psw_pin ( rtc23_t *ctx );

uint8_t rtc23_get_int_pin ( rtc23_t *ctx );

err_t rtc23_check_communication ( rtc23_t *ctx );

err_t rtc23_set_time ( rtc23_t *ctx, rtc23_time_t *time );

err_t rtc23_read_time ( rtc23_t *ctx, rtc23_time_t *time );

err_t rtc23_set_date ( rtc23_t *ctx, rtc23_date_t *date );

err_t rtc23_read_date ( rtc23_t *ctx, rtc23_date_t *date );
 
#ifdef __cplusplus
}
#endif
#endif // RTC23_H
 // rtc23
 
// ------------------------------------------------------------------------ END